Skip to content

Optimize Copilot instructions for clarity and maintainability#1

Closed
waldekmastykarz wants to merge 1 commit into
mainfrom
optimize-copilot-instructions
Closed

Optimize Copilot instructions for clarity and maintainability#1
waldekmastykarz wants to merge 1 commit into
mainfrom
optimize-copilot-instructions

Conversation

@waldekmastykarz
Copy link
Copy Markdown
Owner

Summary

Reorganizes and improves the Copilot instructions file to better serve AI assistants working on this codebase.

Changes

Structure

  • Critical (Non-Obvious): Information Copilot cannot discover through code exploration (proxy engine fork, ~appFolder token, MCP server)
  • Reference (Architecture): Discoverable info kept for cache with prompt caching, this is essentially free after the first turn while saving exploration timeefficiency

New Content

  • Best Practices: Link to comprehensive guide + key points from MCP server docs
  • Testing Guidelines: Always use --as-system-proxy false --port 0 --api-port 0 to avoid conflicts (port 0 lets OS assign random available ports)
  • Plugin Development: Interface selection guidance (IProxyPlugin vs IStdioPlugin)
  • Commits & Releases: Commit message style, semver, homebrew/winget manual updates
  • Auth Workarounds: M365/Azure CLI commands for token acquisition
  • Cleanup: Log file cleanup reminder

Rationale

34 lines) removing "obvious" architecture info. However, with prompt caching, verbose instructions are essentially free after the first while code exploration has real cost every session. Added architecture back as "Reference" section, clearly separated from critical non-discoverable info.request

Testing

Verified --port 0 --api-port 0 behavior: OS correctly assigns random available ports (tested locally, proxy bound to ports 49977/49978).

- Reorganize sections: Critical (non-obvious) vs Reference (architecture)
- Add best practices link and key points from MCP server docs
- Add testing guidelines: use --as-system-proxy false --port 0 --api-port 0
- Add plugin development guidance (interface selection)
- Add commit message and release conventions
- Add M365/Azure auth workaround notes
- Add cleanup instructions for log files

Architecture sections kept for cache efficiency (free after first turn)
while clearly separating non-discoverable critical info.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant